HasXPathTest.java

package org.hamcrest.xml;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.IsEqual.equalTo;
import static org.hamcrest.core.IsNot.not;
import static org.hamcrest.core.StringContains.containsString;
import static org.hamcrest.xml.HasXPath.hasXPath;

import java.io.ByteArrayInputStream;
import java.util.HashSet;
import java.util.Iterator;

import javax.xml.namespace.NamespaceContext;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import org.hamcrest.AbstractMatcherTest;
import org.hamcrest.Matcher;
import org.w3c.dom.Document;

/**
 * @author Joe Walnes
 */
public class HasXPathTest extends AbstractMatcherTest {
    private Document xml;
    private NamespaceContext ns;

    @Override
	protected void setUp() throws Exception {
        super.setUp();
        xml = parse(""
                + "<root type='food'>\n"
                + "  <something id='a'><cheese>Edam</cheese></something>\n"
                + "  <something id='b'><cheese>Cheddar</cheese></something>\n"
                + "  <f:foreignSomething xmlns:f=\"http://cheese.com\" milk=\"camel\">Caravane</f:foreignSomething>\n"
                + "  <emptySomething />\n"
                + "  <f:emptySomething xmlns:f=\"http://cheese.com\" />"
                + "</root>\n"
        );
        ns = new NamespaceContext() {
          public String getNamespaceURI(String prefix) {
              return ("cheese".equals(prefix) ? "http://cheese.com" : null);
          }

          public String getPrefix(String namespaceURI) {
              return ("http://cheese.com".equals(namespaceURI) ? "cheese" : null);
          }

          public Iterator<String> getPrefixes(String namespaceURI) {
              HashSet<String> prefixes = new HashSet<String>();
              String prefix = getPrefix(namespaceURI);
              if (prefix != null) {
                  prefixes.add(prefix);
              }
              return prefixes.iterator();
          }
      };
    }

    @Override
	protected Matcher<?> createMatcher() {
        return hasXPath("//irrelevant");
    }

    public void testAppliesMatcherToXPathInDocument() throws Exception {
        assertThat(xml, hasXPath("/root/something[2]/cheese", equalTo("Cheddar")));
        assertThat(xml, hasXPath("//something[1]/cheese", containsString("dam")));
        assertThat(xml, hasXPath("//something[2]/cheese", not(containsString("dam"))));
        assertThat(xml, hasXPath("/root/@type", equalTo("food")));
        assertThat(xml, hasXPath("//something[@id='b']/cheese", equalTo("Cheddar")));
        assertThat(xml, hasXPath("//something[@id='b']/cheese"));
    }

    public void testMatchesEmptyElement() throws Exception {
        assertThat(xml, hasXPath("//emptySomething"));
    }

    public void testMatchesEmptyElementInNamespace() throws Exception {
      assertThat(xml, hasXPath("//cheese:emptySomething", ns));
    }

    public void testFailsIfNodeIsMissing() throws Exception {
        assertThat(xml, not(hasXPath("/root/something[3]/cheese", ns, equalTo("Cheddar"))));
        assertThat(xml, not(hasXPath("//something[@id='c']/cheese", ns)));
    }

    public void testFailsIfNodeIsMissingInNamespace() throws Exception {
      assertThat(xml, not(hasXPath("//cheese:foreignSomething", equalTo("Badger"))));
      assertThat(xml, not(hasXPath("//cheese:foreignSomething")));
    }

    public void testMatchesWithNamespace() throws Exception {
        assertThat(xml, hasXPath("//cheese:foreignSomething", ns));
        assertThat(xml, hasXPath("//cheese:foreignSomething/@milk", ns, equalTo("camel")));
        assertThat(xml, hasXPath("//cheese:foreignSomething/text()", ns, equalTo("Caravane")));
    }

    public void testThrowsIllegalArgumentExceptionIfGivenIllegalExpression() {
        try {
            hasXPath("\\g:dfgd::DSgf/root/something[2]/cheese", equalTo("blah"));
            fail("Expected exception");
        } catch (IllegalArgumentException expectedException) {
            // expected exception
        }
    }

    public void testDescribesItself() throws Exception {
        assertDescription("an XML document with XPath /some/path \"Cheddar\"",
                hasXPath("/some/path", equalTo("Cheddar")));
        assertDescription("an XML document with XPath /some/path",
                hasXPath("/some/path"));
    }

    public void testDescribesMissingNodeMismatch() {
    	assertMismatchDescription("xpath returned no results.", hasXPath("//honky"), xml);
	}

    public void testDescribesIncorrectNodeValueMismatch() {
    	assertMismatchDescription("xpath result was \"Edam\"", hasXPath("//something[1]/cheese", equalTo("parmesan")), xml);
	}

    private static Document parse(String xml) throws Exception {
        DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
        documentBuilderFactory.setNamespaceAware(true);
        DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
        return documentBuilder.parse(new ByteArrayInputStream(xml.getBytes()));
    }
}